Scripting > CxVhs > VhsClient Helper Objects > ValueEntryEx Object

ValueEntryEx Object

The ValueEntryEx object exposes the fields of the Entry object (type HistoryEntryEx). These include the TimeStamp, TimeStampStr, Status, UserStats, and Value fields. You can still access these fields through the Entry property, as well.

Properties

Property SubType Read Only Description

RollupPeriod

Integer

No

Sets the rollup period. Rollup period refers to the quantity of units in a period. For example, to rollup 30 days, the RollupPeriod is 30 and the RollupUnit is "days."

RollupType

Integer

No

Sets the value entry rollup type. The possible values are listed on the CxRollupType table.

RollupUnits

Integer

No

Sets the rollup units. This refers to time increments, such as seconds, minutes, hours, or days. The possible values are listed on the CxRollupUnits table.

Status

Integer

No

Sets the status word for the history entry. Only bits 2-8 and 11 may be modified. When changing the value of the status word, "OR" the present value of the word with the bit mask of the values you wish to set/clear to preserve value of the status bits that are not being changed.

Example

myHistEntry.Status = hpStatusUnreliable OR

_ myHistEntry.Status

TimeOrdinal

Integer

No

Sets the time ordinal property. The time ordinal property is used to differentiate between entries that have the same timestamp value.

TimeStamp

Date/Time

No

Returns/sets the timestamp for a history entry (Local time without milliseconds).

Note: For records written within the first second after midnight, use TimeStampStr for the hh:mm:ss portion.

TimeStampMs

Date/Time

No

Returns/sets the timestamp for a history entry (Local time with milliseconds).

TimeStampRaw

Date/Time

No

Returns/sets the timestamp for a history entry (UTC time with milliseconds).

TimeStampStr

String

No

Sets the timestamp as a string (includes milliseconds).

UserStatus

Long

No

Sets the point user status (the user status bits in the real-time record).

Value

String

No

Sets the value of the point in the entry record.


Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.